api_result Element

Description

starts a results connection.

Namespace

(none)

Diagram

Overview

api_result

starts a results connection.

Sequence

authentication xs:string

Confirmation that the username and password has been accepted.

num_results xs:int

Defines the number of results in this report.

result 0..∞

There will be a report section for each figure shown in num_results.

Sequence

type xs:string

The type can either be "inbound" or "outbound".

job_num xs:string

This is the number that the PRODOCOM production system uses to identify a specific job. This will be an 8 digit alpha numeric field. The job_num can also be used in the PRODOCOM web portal to locate a job in the reporting option.

client_ref xs:string

This field is for your reference ID for the initial transfer request.

date_gmt xs:string

The GMT (Greenwich Mean time) date that the message was sent.

recip_id xs:string

Your systems id number for the intended recipient.

from optional xs:string

This field is used for inbound fax and SMS numbers and indicates the sender of the message received.

location xs:string

The location can either be "pending" if not yet complete, "transmit" if finished sending, or "received" for an inbound fax or SMS.

recipient xs:string

This will either show the intended recipients delivery address or in the case of an inbound fax or SMS, the inbound number.

seconds xs:int

The total number of seconds of delivery time for this job. In the case of an inbound fax, the number of seconds to receive the fax.

pages_sent xs:int

The number of pages per destination. In the case of an inbound fax or SMS, this will be the total number of pages received.

count xs:int

The total number of destinations in the job.

failed xs:int

The total number of failed destinations in the job.

success xs:int

The total number of successful destinations in the job.

complete xs:int

The total number of completed destinations in the job.

download xs:string

A dcoument Id that can be used to download a copy of the document recieved using the downlaod document request

Source

<xs:element name="api_result" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType>
    <xs:sequence>
      <xs:element type="xs:string" name="authentication" />
      <xs:element type="xs:int" name="num_results" />
      <xs:element name="result" maxOccurs="unbounded" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element type="xs:string" name="type" />
            <xs:element type="xs:string" name="job_num" />
            <xs:element type="xs:string" name="client_ref" />
            <xs:element type="xs:string" name="date_gmt" />
            <xs:element type="xs:string" name="recip_id" />
            <xs:element type="xs:string" name="from" minOccurs="0" />
            <xs:element type="xs:string" name="location" />
            <xs:element type="xs:string" name="recipient" />
            <xs:element type="xs:int" name="seconds" />
            <xs:element type="xs:int" name="pages_sent" />
            <xs:element type="xs:int" name="count" />
            <xs:element type="xs:int" name="failed" />
            <xs:element type="xs:int" name="success" />
            <xs:element type="xs:int" name="complete" />
            <xs:element type="xs:string" name="download" />
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
</xs:element>